/*
 * Fichier: Book.java
 * Crée le: 07 septembre 2007.
 * Modifié: 26 avril 2012.
 * Auteurs: Sébastien ESTIENNE.
 * SiteWeb: http://www.prog-info.org/
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package javaexos.business;

import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.swing.event.EventListenerList;

import javaexos.model.BookMutableModel;
import javaexos.model.ChapterModel;
import javaexos.model.ChapterMutableModel;
import javaexos.tools.Constants;

/**
 * <p>Classe décrivant les chapitres et leurs exercices.</p>
 * @author Sébastien ESTIENNE.
 */
public class Book implements BookMutableModel
{
   /** Liste des chapitres. */
   protected List<ChapterMutableModel> chapters;
   
   /** Une liste d'écouteurs d'événement pour cette classe. */
   private EventListenerList listenerList = new EventListenerList();
   
   /**
    * <p>Constructeur par défaut de livre.</p>
    */
   public Book()
   {
      // Initialisation.
      this(new ArrayList<ChapterMutableModel>());
   }
   
   /**
    * <p>Constructeur de livre.</p>
    * @param chapters La liste des chapitres du livre.
    */
   public Book(List<ChapterMutableModel> chapters)
   {
      // Initialisation.
      this.chapters = chapters;
   }
   
   /**
    * <p>Renvoie la liste des chapitres d'exercices.</p>
    * @return Retourne la liste des chapitres d'exercices.
    */
   public List< ? extends ChapterModel> getChapters()
   {
      return Collections.unmodifiableList(this.chapters);
   }


   /**
    * <p>Modifie la liste des chapitres d'exercices.</p>
    * @param chapters La nouvelle liste des chapitres d'exercices.
    */
   public void setChapters(List<ChapterMutableModel> chapters)
   {
      assert (chapters != null) : "'chapters' ne doit pas être null!";

      this.chapters.clear();
      this.chapters.addAll(chapters);
   }
   
   /**
    * <p>Charge les donnés de tous les chapitres.</p>
    */
   public void loadChapters()
   {
      // Cette méthode peut être redéfinie pour charger les chapitres à partir d'un fichier TXT ou 
      // XML par exemple.
   }
   
   /**
    * <p>Extrait les informations d'un chapitre contenues dans un fichier XML.</p>
    * @param filename Le chemin vers le fichier.
    * @return Retourne un chapitre avec les informations du fichier.
    */
   public ChapterMutableModel parseChapter(URL filename)
   {
      // Cette méthode peut être redéfinie pour charger les chapitres à partir d'un fichier TXT ou 
      // XML par exemple.
      return null;
   }
   
   /**
    * <p>Ajoute un composant dans la liste de ceux qui veulent être informés d'un événement de 
    * chapitre chargé.</p>
    * @param l L'écouteur de chapitre chargé.
    */
   public void addChapterListener(ChapterListener l)
   {
      this.listenerList.add(ChapterListener.class, l);
   }


   /**
    * <p>Supprime un composant de la liste de ceux qui veulent être informés d'un événement de 
    * chapitre chargé.</p>
    * @param l L'écouteur de chapitre chargé.
    */
   public void removeChapterListener(ChapterListener l)
   {
      this.listenerList.remove(ChapterListener.class, l);
   }


   /**
    * <p>Lance un évènement à tous les objets écouteurs.</p>
    * @param number Le numéro du chapitre.
    * @param title Le titre du chapitre.
    */
   protected void fireChapterLoaded(int number, String title)
   {
      ChapterListener[] listeners = this.listenerList.getListeners(ChapterListener.class);
      ChapterEvent e = new ChapterEvent(this, number, title);
      for(ChapterListener l : listeners)
      {
         l.chapterLoaded(e);
      }
   }
   
   
   /**
    * <p>Retourne une représentation du livre.</p>
    * @return Renvoie une représentation du livre.
    */
   @Override
   public String toString()
   {
      StringBuilder resultat = new StringBuilder();

      resultat.append(Constants.BOOK_NAME);

      return resultat.toString();
   }
}
